home *** CD-ROM | disk | FTP | other *** search
/ Pluspack 1 / Caligari Corporation Pluspack1 1998.iso / TSX_SDK / tsxINC / tsxGeom.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-01-28  |  8.4 KB  |  225 lines
  1. //******************************************************************************
  2. //    File: tsxGeom.h
  3. //  Module: trueSpace eXtensions API
  4. //   Descr: Basic geometric manipulation in 2D and 3D.
  5. //******************************************************************************
  6.  
  7. #ifndef TSXGEOM_H
  8. #define TSXGEOM_H
  9.  
  10. #include <math.h>
  11. #include "tsxTypes.h"    //Basic data types
  12.  
  13.  
  14. //------------------------------------------------------------------------------
  15. //    General comments
  16. //------------------------------------------------------------------------------
  17.  
  18. /*
  19. ** `float' is used as the basic scalar data type.
  20. ** 
  21. ** 3D types have suffix "3f" and 2D data-types have suffix "2f".
  22. ** The functions have similar suffixes.
  23. ** 
  24. ** All normal and axis vectors used as arguments in functions are assumed to be
  25. ** unit vectors.
  26. ** 
  27. ** trueSpace uses a "Right-handed" spatial orientation.
  28. **
  29. ** All types are defined in "tsxTypes.h".
  30. */
  31.  
  32. //------------------------------------------------------------------------------
  33. //    Basics
  34. //------------------------------------------------------------------------------
  35.  
  36. #ifndef M_PI
  37. #define M_PI 3.14159265359
  38. #endif
  39.  
  40. // 180/pi
  41. #define tsxRAD2DEG_FAC 57.29577951308f
  42. // pi/180
  43. #define tsxDEG2RAD_FAC  0.01745329251994f
  44.  
  45. // Radians -> Degrees
  46. inline float tsxRad2Deg( const float rad )
  47. {
  48.     return (rad * tsxRAD2DEG_FAC);
  49. }
  50.  
  51. // Degrees -> Radians
  52. inline float tsxDeg2Rad( const float deg )
  53. {
  54.     return (deg * tsxDEG2RAD_FAC);
  55. }
  56.  
  57.  
  58. //------------------------------------------------------------------------------
  59. //    Vector Geometry
  60. //------------------------------------------------------------------------------
  61.  
  62. // |vect|
  63. TSXAPIFN float tsxMagnitude3f( const CtsxVector3f& vec );
  64. TSXAPIFN float tsxMagnitude2f( const CtsxVector2f& vec );
  65.  
  66. //    Normalizing ... returns the length of the original vector `vec'.
  67. TSXAPIFN float tsxNormalize3f( CtsxVector3f& vec );
  68. TSXAPIFN float tsxNormalize2f( CtsxVector2f& vec );
  69. // norm = vec/|vec|
  70. TSXAPIFN float tsxGetNormalized3f( CtsxVector3f& norm, const CtsxVector3f& vec );
  71. TSXAPIFN float tsxGetNormalized2f( CtsxVector2f& norm, const CtsxVector2f& vec );
  72.  
  73. //    Scalar-Vector arithmetic ... `vec' is modified and returned
  74. // vec = vec + s
  75. TSXAPIFN CtsxVector3f& tsxAddScalar3f( CtsxVector3f& vec, const float s );
  76. // vec = vec * s
  77. TSXAPIFN CtsxVector3f& tsxMulScalar3f( CtsxVector3f& vec, const float s );
  78.  
  79. //    Vector-Vector arithmetic ... Vector `u' is modified and returned
  80. // u = u + v
  81. TSXAPIFN CtsxVector3f& tsxAddVec3f( CtsxVector3f& u, const CtsxVector3f& v );
  82. // u = u - v
  83. TSXAPIFN CtsxVector3f& tsxSubVec3f( CtsxVector3f& u, const CtsxVector3f& v );
  84.  
  85. //    Vector Multiplication
  86. // u . v ... Dot Product
  87. TSXAPIFN float tsxDProdVec3f( const CtsxVector3f& u, const CtsxVector3f& v );
  88. // uxv = u x v ... Cross Product
  89. TSXAPIFN CtsxVector3f& tsxXProdVec3f( CtsxVector3f& uxv,
  90.                       const CtsxVector3f& u,
  91.                       const CtsxVector3f& v);
  92.  
  93. // Returns Signed angle from vector `u' to `v' about the axis `axis'.
  94. // `axis' gets the (unnormalized) cross-product (axis = u x v). Angle in radians.
  95. TSXAPIFN float tsxAngleBtwVecs3f( const CtsxVector3f& u, const CtsxVector3f& v,
  96.                   CtsxVector3f& axis );
  97.  
  98.  
  99. //------------------------------------------------------------------------------
  100. //    Distances from a Point
  101. //------------------------------------------------------------------------------
  102.  
  103. // Note: CtsxVector is used to represent the cartesian coordinates of a point.
  104.  
  105. //    Distances are non-negative unless mentioned otherwise.
  106.  
  107. // Distance between 2 points `p', `q'.
  108. TSXAPIFN float tsxDistanceToPoint3f( const CtsxVector3f& p,
  109.                      const CtsxVector3f& q );
  110. // Distance from a point `p' to a line containing point `line_point' and
  111. // with unit direction vector `line_unitvec'.
  112. TSXAPIFN float tsxDistanceToLine3f( const CtsxVector3f& p,
  113.                     const CtsxVector3f& line_point,
  114.                     const CtsxVector3f& line_unitvec );
  115. // Distance from a Point `p' to a Plane with normal `plane_norm' and
  116. // containing Point `plane_point'. This distance is positive only if
  117. // `plane_norm' points towards `p'.
  118. TSXAPIFN float tsxDistanceToPlane3f( const CtsxVector3f& p,
  119.                      const CtsxVector3f& plane_norm,
  120.                      const CtsxVector3f& plane_point );
  121.  
  122.  
  123. //------------------------------------------------------------------------------
  124. //    Transformation Matrices
  125. //------------------------------------------------------------------------------
  126.  
  127. // A = B x C ... Matrix Multiplication.
  128. // A may be the same as B or C.
  129. TSXAPIFN CtsxTxmx3f& tsxXProdMx3f( CtsxTxmx3f& A,
  130.                    const CtsxTxmx3f& B, const CtsxTxmx3f& C );
  131.  
  132. // Minv = Inverse(M) ... Matrix Inverse
  133. // Returns e_tsxFAILURE if result is not reliable.
  134. TSXAPIFN tsxRET tsxInvertMx3f( CtsxTxmx3f& Minv, const CtsxTxmx3f& M );
  135.  
  136. // Makes Transformation Matrix from specified X and Z axes and Origin.
  137. // pTxmx points to matrix where result Transformation Matrix is stored.
  138. // If pInvTxmx is specified, the inverted Transform is stored there.
  139. // Returns reference to Txmx.
  140. TSXAPIFN CtsxTxmx3f& tsxMakeMxFromXZO3f( const CtsxVector3f& xAxis,
  141.                      const CtsxVector3f& zAxis,
  142.                      const CtsxVector3f& origin,
  143.                      CtsxTxmx3f* pTxmx,
  144.                      CtsxTxmx3f* pInvTxmx = 0 );
  145.  
  146. // Makes a transformation matrix for rotation by `angle' about a line
  147. // defined by the center point `cent' and the normalized axis vector `axis'.
  148. // Returns reference to Txmx.
  149. TSXAPIFN CtsxTxmx3f& tsxMakeRotMx3f( const CtsxVector3f& cent,
  150.                      const CtsxVector3f& axis,
  151.                      float angle,   //radians
  152.                      CtsxTxmx3f* pTxmx,
  153.                      CtsxTxmx3f* pInvTxmx = 0 );
  154. // This version builds a pure rotation matrix, leaving other cells untouched.
  155. // The rotation is about a (unit) vector `axis'.
  156. TSXAPIFN CtsxTxmx3f& tsxMakePureRotMx3f( const CtsxVector3f& axis,
  157.                      float angle, //radians
  158.                      CtsxTxmx3f* pTxmx,
  159.                      CtsxTxmx3f* pInvTxmx = 0 );
  160.  
  161. //     Translation in the Txmx
  162. // Get the translation components {x, y, z} into `trvec'.
  163. TSXAPIFN CtsxVector3f& tsxGetMxTranslation3f( CtsxVector3f& trvec,
  164.                           const CtsxTxmx3f& Txmx );
  165. // Set the translation components of a Txmx
  166. TSXAPIFN CtsxTxmx3f& tsxSetMxTranslation3f( CtsxTxmx3f& Txmx,
  167.                         const CtsxVector3f& trvec );
  168. // Add translation vector `trvec' to Txmx
  169. TSXAPIFN CtsxTxmx3f& tsxAddMxTranslation3f( CtsxTxmx3f& Txmx,
  170.                         const CtsxVector3f& trvec );
  171. // Subtract translation vector `trvec' from Txmx
  172. TSXAPIFN CtsxTxmx3f& tsxSubMxTranslation3f( CtsxTxmx3f& Txmx,
  173.                         const CtsxVector3f& trvec );
  174.  
  175. // Extract the pure rotation matrix (Rot) and scaling/shearing factors
  176. // from a Transformation Matrix (Txmx).
  177. // If specified, pScaleShear must be float[6], and is assigned as follows:
  178. //      { Sx, Sy, Sz, Sxy, Sxz, Syz }
  179. TSXAPIFN void tsxUnMatrix3f( const CtsxTxmx3f& Txmx,
  180.                  CtsxTxmx3f& Rot,
  181.                  float* pScaleShear = 0 );
  182.  
  183. //------------------------------------------------------------------------------
  184. //    Applying the Transformation Matrix
  185. //------------------------------------------------------------------------------
  186.  
  187. // Transform an array of vectors `pInVecs', placing result in `pOutVecs'.
  188. TSXAPIFN void tsxTransformVecs3f( int numVecs,
  189.                   CtsxVector3f* pOutVecs,
  190.                   const CtsxVector3f* pInVecs,
  191.                   const CtsxTxmx3f& Txmx );
  192. // Apply only the rotational part of the Txmx to an array of vectors.
  193. TSXAPIFN void tsxRotateVecs3f( int numVecs,
  194.                    CtsxVector3f* pOutVecs,
  195.                    const CtsxVector3f* pInVecs,
  196.                    const CtsxTxmx3f& Txmx );
  197.  
  198. // OutAxes = Rotate InAxes using Txmx. Ignore non-rotational part of Txmx.
  199. // IF InAxes are orthogonal and unit, then OutAxes are also valid axes.
  200. TSXAPIFN void tsxRotateAxes3f( CtsxAxes3f* pOutAxes,
  201.                    CtsxAxes3f* pInAxes,
  202.                    const CtsxTxmx3f& Txmx );
  203.  
  204.  
  205. //------------------------------------------------------------------------------
  206. //    Bounding Box
  207. //------------------------------------------------------------------------------
  208.  
  209. // Initialize BBox to negative volume.
  210. TSXAPIFN void tsxBBoxInit( CtsxBBox3f* pBBox );
  211.  
  212. // Returns e_tsxTRUE if BBox1 and BBox2 intersect.
  213. // If they do intersect, and pBBintx is non-zero,
  214. // then BBintx gets their intersection.
  215. TSXAPIFN tsxBOOL tsxBBoxIntersection(
  216.     CtsxBBox3f* pBBintx,
  217.     CtsxBBox3f* pBBox1,
  218.     CtsxBBox3f* pBBox2
  219.     );
  220.  
  221.  
  222.  
  223. //******************************************************************************
  224. #endif // TSXGEOM_H
  225.